KEH-1227: Rewrite Docs #67
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Contributor
🦙 MegaLinter status:
|
| Descriptor | Linter | Files | Fixed | Errors | Warnings | Elapsed time |
|---|---|---|---|---|---|---|
| bash-exec | 6 | 4 | 0 | 0.04s | ||
| ✅ BASH | shellcheck | 6 | 0 | 0 | 0.13s | |
| ✅ BASH | shfmt | 6 | 0 | 0 | 0.01s | |
| ✅ CSHARP | csharpier | 1 | 0 | 0 | 0.39s | |
| ✅ DOCKERFILE | hadolint | 1 | 0 | 0 | 0.09s | |
| ✅ JSON | jsonlint | 2 | 0 | 0 | 0.21s | |
| ✅ JSON | prettier | 2 | 0 | 0 | 0.62s | |
| ✅ JSON | v8r | 2 | 0 | 0 | 3.06s | |
| ✅ MARKDOWN | markdownlint | 7 | 0 | 0 | 0.92s | |
| ✅ MARKDOWN | markdown-table-formatter | 7 | 0 | 0 | 0.35s | |
| ✅ REPOSITORY | checkov | yes | no | no | 27.86s | |
| ✅ REPOSITORY | dustilock | yes | no | no | 0.01s | |
| ✅ REPOSITORY | gitleaks | yes | no | no | 7.65s | |
| ✅ REPOSITORY | grype | yes | no | no | 53.71s | |
| ✅ REPOSITORY | kics | yes | no | no | 46.98s | |
| ✅ REPOSITORY | secretlint | yes | no | no | 1.09s | |
| ✅ REPOSITORY | syft | yes | no | no | 4.45s | |
| ✅ REPOSITORY | trivy | yes | no | no | 14.67s | |
| ✅ REPOSITORY | trivy-sbom | yes | no | no | 0.51s | |
| ✅ TERRAFORM | terraform-fmt | 6 | 0 | 0 | 0.49s | |
| ✅ YAML | prettier | 8 | 0 | 0 | 1.03s | |
| ✅ YAML | v8r | 8 | 0 | 0 | 6.93s | |
| ✅ YAML | yamllint | 8 | 0 | 0 | 0.72s |
See detailed report in MegaLinter reports
You could have same capabilities but better runtime performances if you request a new MegaLinter flavor.
MegaLinter is graciously provided by OX Security
- Update list of Copilot data types fetched - Move environment variables to top-level setup and remove duplication
- Update list of Copilot data types fetched - Fix architecture diagram link - Change Copilot day count following API update
- Remove old Streamlit paragraph
- Add section for Copilot teams data
Contributor
|
Grype issue has fixed itself 🔥 |
sebtheo
approved these changes
Jan 5, 2026
mwirikia
reviewed
Jan 14, 2026
| #### Regular User | ||
|
|
||
| A user within ONSDigital. Upon authentication, the app identifies the teams they belong to and populates the selection box accordingly. If the user is part of a qualifying team, they can view the data. Users not associated with any team cannot select teams. | ||
| A user within ONSDigital. Upon authentication, the app identifies the teams they belong to and populates the UI selection accordingly. If the user is part of a qualifying team, they can view the data. Users not associated with any team cannot select teams. |
Contributor
There was a problem hiding this comment.
Could we rewrite the first sentence to maybe, For a user within ONSDigital, upon ...
| #### Admin User | ||
|
|
||
| An enhanced regular user with the ability to search for any team. This user belongs to a specific whitelisted team, enabling them to view metrics for any team that meets the Copilot usage data requirements. | ||
| An enhanced regular user with the ability to view any team. This user belongs to a specific whitelisted team, enabling them to view metrics for any team that meets the Copilot usage data requirements. |
Contributor
There was a problem hiding this comment.
Same as the other comment, the first sentence needs to be restructured.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What type of PR is this? (check all applicable)
What
Documentation refresh following Copilot lambda updates.
Testing
Have any new tests been added as part of this issue? If not, try to explain why test coverage is not needed here.
Please write a brief description of why test coverage is not necessary here.
Documentation
Has any new documentation been written as part of this issue? We should try to keep documentation up to date
as new code is added, rather than leaving it for the future.
Please write a brief description of why documentation is not necessary here.
Related issues
KEH-1227
How to review
Read through README.md and markdown files within
docs.